/
IndexBuilder`1.xml
207 lines (207 loc) · 13.5 KB
/
IndexBuilder`1.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
<Type Name="IndexBuilder<T>" FullName="Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T>">
<TypeSignature Language="C#" Value="public class IndexBuilder<T> : Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IndexBuilder`1<T> extends Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1" />
<TypeSignature Language="VB.NET" Value="Public Class IndexBuilder(Of T)
Inherits IndexBuilder" />
<TypeSignature Language="F#" Value="type IndexBuilder<'T> = class
 inherit IndexBuilder" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Base>
<BaseTypeName>Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>
Provides a simple API for configuring an <see cref="T:Microsoft.EntityFrameworkCore.Metadata.IMutableIndex" />.
</summary>
<remarks>
<para>
Instances of this class are returned from methods when using the <see cref="T:Microsoft.EntityFrameworkCore.ModelBuilder" /> API
and it is not designed to be directly constructed in your application code.
</para>
<para>
See <see href="https://aka.ms/efcore-docs-modeling">Modeling entity types and relationships</see> for more information and
examples.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IndexBuilder (Microsoft.EntityFrameworkCore.Metadata.IMutableIndex index);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.EntityFrameworkCore.Metadata.IMutableIndex index) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1.#ctor(Microsoft.EntityFrameworkCore.Metadata.IMutableIndex)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (index As IMutableIndex)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T> : Microsoft.EntityFrameworkCore.Metadata.IMutableIndex -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T>" Usage="new Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T> index" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0">
<AttributeName Language="C#">[Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal]</AttributeName>
<AttributeName Language="F#">[<Microsoft.EntityFrameworkCore.Infrastructure.EntityFrameworkInternal>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="index" Type="Microsoft.EntityFrameworkCore.Metadata.IMutableIndex" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0;efcore-6.0;efcore-7.0;efcore-8.0" />
</Parameters>
<Docs>
<param name="index">To be added.</param>
<summary>
This is an internal API that supports the Entity Framework Core infrastructure and not subject to
the same compatibility standards as public APIs. It may be changed or removed without notice in
any release. You should only use it directly in your code with extreme caution and knowing that
doing so can result in application failures when updating to a new Entity Framework Core release.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IndexBuilder (Microsoft.EntityFrameworkCore.Metadata.Internal.InternalIndexBuilder builder);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.EntityFrameworkCore.Metadata.Internal.InternalIndexBuilder builder) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1.#ctor(Microsoft.EntityFrameworkCore.Metadata.Internal.InternalIndexBuilder)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (builder As InternalIndexBuilder)" />
<MemberSignature Language="F#" Value="new Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T> : Microsoft.EntityFrameworkCore.Metadata.Internal.InternalIndexBuilder -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T>" Usage="new Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T> builder" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="builder" Type="Microsoft.EntityFrameworkCore.Metadata.Internal.InternalIndexBuilder" Index="0" FrameworkAlternate="efcore-2.2" />
</Parameters>
<Docs>
<param name="builder">To be added.</param>
<summary>
This API supports the Entity Framework Core infrastructure and is not intended to be used
directly from your code. This API may change or be removed in future releases.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasAnnotation">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T> HasAnnotation (string annotation, object value);" FrameworkAlternate="efcore-2.2;efcore-3.0;efcore-3.1;efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1<!T> HasAnnotation(string annotation, object value) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1.HasAnnotation(System.String,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function HasAnnotation (annotation As String, value As Object) As IndexBuilder(Of T)" />
<MemberSignature Language="F#" Value="override this.HasAnnotation : string * obj -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T>" Usage="indexBuilder.HasAnnotation (annotation, value)" />
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T> HasAnnotation (string annotation, object? value);" FrameworkAlternate="efcore-6.0;efcore-7.0;efcore-8.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotation" Type="System.String" />
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="annotation">The key of the annotation to be added or updated.</param>
<param name="value">The value to be stored in the annotation.</param>
<summary>
Adds or updates an annotation on the index. If an annotation with the key specified in
<paramref name="annotation" />
already exists its value will be updated.
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsDescending">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T> IsDescending (params bool[] descending);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1<!T> IsDescending(bool[] descending) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1.IsDescending(System.Boolean[])" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function IsDescending (ParamArray descending As Boolean()) As IndexBuilder(Of T)" />
<MemberSignature Language="F#" Value="override this.IsDescending : bool[] -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T>" Usage="indexBuilder.IsDescending descending" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="descending" Type="System.Boolean[]" Index="0" FrameworkAlternate="efcore-7.0;efcore-8.0">
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ParamArray]</AttributeName>
<AttributeName Language="F#">[<System.ParamArray>]</AttributeName>
</Attribute>
</Attributes>
</Parameter>
</Parameters>
<Docs>
<param name="descending">
A set of values indicating whether each corresponding index column has descending sort order.
An empty list indicates that all index columns will have descending sort order.
</param>
<summary>
Configures the sort order(s) for the columns of this index (ascending or descending).
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsUnique">
<MemberSignature Language="C#" Value="public virtual Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T> IsUnique (bool unique = true);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1<!T> IsUnique(bool unique) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder`1.IsUnique(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function IsUnique (Optional unique As Boolean = true) As IndexBuilder(Of T)" />
<MemberSignature Language="F#" Value="override this.IsUnique : bool -> Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<'T>" Usage="indexBuilder.IsUnique unique" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>2.2.6.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.Builders.IndexBuilder<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="unique" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="unique">A value indicating whether this index is unique.</param>
<summary>
Configures whether this index is unique (i.e. the value(s) for each instance must be unique).
</summary>
<returns>The same builder instance so that multiple configuration calls can be chained.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>